tslint

What is tslint?

The tslint npm package is a static analysis tool that checks TypeScript code for readability, maintainability, and functionality errors. It is widely used to enforce a consistent code style by checking the code against a set of linting rules.

What are tslint's main functionalities?

Linting TypeScript Files

This feature allows you to lint TypeScript files by specifying a configuration file and a pattern to match files. The command will process all TypeScript files in the 'src' directory and its subdirectories.

tslint -c tslint.json 'src/**/*.ts'

Fixing Linting Errors Automatically

This feature automatically fixes linting errors that can be corrected without human intervention. It is useful for fixing simple issues like whitespace or semicolon usage.

tslint --fix -c tslint.json 'src/**/*.ts'

Custom Rules

This feature allows you to use custom linting rules in addition to the predefined rules. You can specify a directory containing custom rule definitions to be applied to your code.

tslint -c tslint.json 'src/**/*.ts' --rules-dir custom_rules

Other packages similar to tslint

eslint

ESLint is a popular linting tool for JavaScript and TypeScript. It is highly configurable and extendable, with a large ecosystem of plugins. ESLint has effectively replaced TSLint as the preferred linter for TypeScript after TSLint's deprecation.

prettier

Prettier is an opinionated code formatter that supports many languages, including TypeScript. While it does not perform static code analysis, it formats code to a consistent style. Prettier can be used alongside linters like ESLint.

stylelint

Stylelint is a modern linter that helps you avoid errors and enforce conventions in your stylesheets. Although it is primarily used for CSS, it can be used in conjunction with PostCSS to lint SCSS, Sass, Less, and other CSS-like languages.

README

TSLint

TSLint is an extensible static analysis tool that checks TypeScript code for readability, maintainability, and functionality errors. It is widely supported across modern editors & build systems and can be customized with your own lint rules, configurations, and formatters.

:warning: TSLint will be deprecated some time in 2019. See this issue for more details: Roadmap: TSLint → ESLint. If you're interested in helping with the TSLint/ESLint migration, please check out our OSS Fellowship program.

TSLint currently supports:

• an extensive set of core rules
• custom lint rules
• custom formatters (failure reporters)
• inline disabling and enabling of rules with comment flags in source code
• configuration presets (tslint:latest, tslint-react, etc.) and plugin composition
• automatic fixing of formatting & style violations
• integration with MSBuild, Grunt, Gulp, Atom, Eclipse, Emacs, Sublime, Vim, Visual Studio 2015, Visual Studio 2017, Visual Studio code (alternative: use this extension for TS <3.2), WebStorm and more

Installation & Usage

Please refer to the full installation & usage documentation on the TSLint website. There, you'll find information about

• configuration,
• core rules,
• core formatters, and
• customization of TSLint.
• inline disabling and enabling of rules with comment flags

TSLint Playground

There is a sandbox environment for TSLint at palantir.github.io/tslint-playground, which can be used to test rules and see how TSLint works. Issues can be filed against tslint-playground here.

Custom Rules & Plugins

Custom rule sets from Palantir

• tslint-react - Lint rules related to React & JSX.
• tslint-blueprint - Lint rules to enforce best practices with blueprintjs libraries

Custom rule sets from the community

If we don't have all the rules you're looking for, you can either write your own custom rules or use rules implementations developed by the community. The repos below are a good source of custom rules:

• ESLint rules for TSLint - Improve your TSLint with the missing ESLint Rules
• tslint-microsoft-contrib - A set of TSLint rules used on some Microsoft projects
• codelyzer - A set of tslint rules for static code analysis of Angular TypeScript projects
• vrsource-tslint-rules
• tslint-immutable - TSLint rules to disable mutation in TypeScript
• tslint-consistent-codestyle - TSLint rules to enforce consistent code style in TypeScript
• tslint-sonarts - Bug-finding rules based on advanced code models to spot hard to find errors in TypeScript
• tslint-clean-code - A set of TSLint rules inspired by the Clean Code handbook
• rxjs-tslint-rules - TSLint rules for RxJS

Development

Prerequisites:

• node v7+
• yarn v1.0+

Quick Start

git clone [e-mail]:palantir/tslint.git --config core.autocrlf=input --config core.eol=lf
yarn
yarn compile
yarn test

Changelog

v5.20.1

No changes from v5.20.0, just re-released to correctly mark with the latest dist-tag on NPM.